2020-07-02

SSM-使用Hibernate Validator进行后端校验

字数统计: 415字 | 阅读时长: 1分

一、前言

平时项目中，难免需要对参数进行一些参数正确性的校验，这些校验出现在业务代码中，让我们的业务代码显得臃肿，而且，频繁的编写这类参数校验代码很无聊。鉴于此，觉得 Hibernate Validator 工具刚好解决了这些问题，可以很优雅的方式实现参数的校验，让业务代码和校验逻辑分开,不再编写重复的校验逻辑。

最近在练习时也使用到了该工具，故记录一下使用步骤。

二、Hibernate Validator 的使用

1、导入jar包

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.5.Final</version>
</dependency>

MVN Repository：
Hibernate Validator Engine

2、Java对象添加约束注解

public class Employee {
    private Integer empId;

    @Pattern(regexp = "(^[a-zA-Z0-9_-]{5,10}$)|(^[\\u2E80-\\u9FFF]{2,5})",
            message = "用户名必须为2-5位中文或5-10位英文与数字的组合！")
    private String empName;

    private String gender;

    @Pattern(regexp = "^([a-z0-9_\\.-]+)@([\\da-z\\.-]+)\\.([a-z\\.]{2,6})$",
            message = "邮箱格式不正确！")
    private String email;

    private Integer dId;

    private Department department;

    //setters and getters
}

3、在封装参数处启用

使用 @Valid 注解开启使用
校验的结果会封装到 BindingResult 对象中

/**
 * 保存员工信息
 * @return
 */
@RequestMapping(value = "/saveEmp")
public @ResponseBody Msg saveEmp(@Valid Employee employee, BindingResult result){
    if(result.hasErrors()){ //校验失败
        Map<String,String> errors = new HashMap<String,String>();
        List<FieldError> fieldErrors = result.getFieldErrors();
        for (FieldError fieldError : fieldErrors) {
            errors.put(fieldError.getField(),fieldError.getDefaultMessage());
        }
        return Msg.fail().add("errors", errors);
    }else{  //校验成功
        employeeService.saveEmp(employee);
        return Msg.success();
    }
}

Java新手，若有错误，欢迎指正！

| 阅读量次